Update README.md with more specific instructions around adding a package #1100
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
diogoasouza
reviewed
Jan 15, 2025
README.md
Outdated
| 3. Create a pull request for your changes targeting the `main-source` branch in | ||
| this repository. **Please ensure that your pull request only contains changes | ||
| related to the package that you are adding.** The `PACKAGE` environment variable | ||
| is useful for this; for more information please see the `partner-charts-ci` |
There was a problem hiding this comment.
Maybe add the link to the partner-charts-ci documentation here as well?
There was a problem hiding this comment.
Specifically, link to the example that uses the env var
troytop
requested changes
Jan 15, 2025
README.md
Outdated
| 3. Create a pull request for your changes targeting the `main-source` branch in | ||
| this repository. **Please ensure that your pull request only contains changes | ||
| related to the package that you are adding.** The `PACKAGE` environment variable | ||
| is useful for this; for more information please see the `partner-charts-ci` |
There was a problem hiding this comment.
Specifically, link to the example that uses the env var
troytop
approved these changes
Jan 16, 2025
diogoasouza
approved these changes
Jan 16, 2025
adamkpickering
deleted the
improve-readme-package-addition-exclusive-changes
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It is important that pull requests that add a package contain changes that are related to only that package. This PR makes a small change to the documentation saying that, as well as how a developer can achieve that.